ninab222.h File Reference

This file contains API for NINA-B222 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"

Go to the source code of this file.

Data Structures
struct	ninab222_t
	NINA-B222 Click context object. More...
struct	ninab222_cfg_t
	NINA-B222 Click configuration object. More...

Macros
#define	NINAB222_CMD_AT   "AT"
	NINA-B222 AT command.
#define	NINAB222_CMD_CGMI   "CGMI"
	NINA-B222 general commands.
#define	NINAB222_CMD_CGMM   "CGMM"
#define	NINAB222_CMD_CGMR   "CGMR"
#define	NINAB222_CMD_CGSN   "CGSN"
#define	NINAB222_CMD_GMI   "GMI"
#define	NINAB222_CMD_GMM   "GMM"
#define	NINAB222_CMD_GMR   "GMR"
#define	NINAB222_CMD_GSN   "GSN"
#define	NINAB222_CMD_ATI   "ATI"
#define	NINAB222_CMD_CSGT   "CSGT"
#define	NINAB222_CMD_ATW   "W"
	NINA-B222 system commands.
#define	NINAB222_CMD_ATZ   "ATZ"
#define	NINAB222_CMD_ATE   "ATE"
#define	NINAB222_CMD_UFACTORY   "UFACTORY"
#define	NINAB222_CMD_ATD   "D"
#define	NINAB222_CMD_ATS   "S"
#define	NINAB222_CMD_CPWROFF   "CPWROFF"
#define	NINAB222_CMD_UFWUPD   "UFWUPD"
#define	NINAB222_CMD_UMLA   "UMLA"
#define	NINAB222_CMD_UMLPO   "UMLPO"
#define	NINAB222_CMD_UMRS   "UMRS"
#define	NINAB222_CMD_UMRSCFG   "UMRSCFG"
#define	NINAB222_CMD_UMRSIG   "UMRSIG"
#define	NINAB222_CMD_UMSM   "UMSM"
#define	NINAB222_CMD_UMSTAT   "UMSTAT"
#define	NINAB222_CMD_UPWRMNG   "UPWRMNG"
#define	NINAB222_CMD_UPWRREG   "UPWRREG"
#define	NINAB222_CMD_USTOP   "USTOP"
#define	NINAB222_CMD_ATO   "ATO"
	NINA-B222 data mode commands.
#define	NINAB222_CMD_UDATR   "UDATR"
#define	NINAB222_CMD_UDATW   "UDATW"
#define	NINAB222_CMD_UDBIND   "UDBIND"
#define	NINAB222_CMD_UDBINDC   "UDBINDC"
#define	NINAB222_CMD_UDCFG   "UDCFG"
#define	NINAB222_CMD_UDCP   "UDCP"
#define	NINAB222_CMD_UDCPC   "UDCPC"
#define	NINAB222_CMD_UDDRP   "UDDRP"
#define	NINAB222_CMD_UDLP   "UDLP"
#define	NINAB222_CMD_UDSC   "UDSC"
#define	NINAB222_CMD_UDSF   "UDSF"
#define	NINAB222_CMD_UDUV   "UDUV"
#define	NINAB222_CMD_UDWS   "UDWS"
#define	NINAB222_CMD_UUDATA   "UUDATA"
#define	NINAB222_CMD_UUDPC   "UUDPC"
#define	NINAB222_CMD_UUDPD   "UUDPD"
#define	NINAB222_CMD_UBTDM   "UBTDM"
	NINA-B222 bluetooth commands.
#define	NINAB222_CMD_UBTCM   "UBTCM"
#define	NINAB222_CMD_UBTPM   "UBTPM"
#define	NINAB222_CMD_UBTSM   "UBTSM"
#define	NINAB222_CMD_UBTST   "UBTST"
#define	NINAB222_CMD_UBTUC   "UBTUC"
#define	NINAB222_CMD_UBTUPE   "UBTUPE"
#define	NINAB222_CMD_UBTOTK   "UBTOTK"
#define	NINAB222_CMD_UBTND   "UBTND"
#define	NINAB222_CMD_UBTI   "UBTI"
#define	NINAB222_CMD_UBTD   "UBTD"
#define	NINAB222_CMD_UBTBD   "UBTBD"
#define	NINAB222_CMD_UBTB   "UBTB"
#define	NINAB222_CMD_UBTUB   "UBTUB"
#define	NINAB222_CMD_UBTLN   "UBTLN"
#define	NINAB222_CMD_UBTLC   "UBTLC"
#define	NINAB222_CMD_UBTMSR   "UBTMSR"
#define	NINAB222_CMD_UBTMSP   "UBTMSP"
#define	NINAB222_CMD_UBTRSS   "UBTRSS"
#define	NINAB222_CMD_UBTLQ   "UBTLQ"
#define	NINAB222_CMD_UBTLE   "UBTLE"
#define	NINAB222_CMD_UBTAD   "UBTAD"
#define	NINAB222_CMD_UBTSS   "UBTSS"
#define	NINAB222_CMD_UBTWS   "UBTWS"
#define	NINAB222_CMD_UBTCFG   "UBTCFG"
#define	NINAB222_CMD_UBTLECFG   "UBTLECFG"
#define	NINAB222_CMD_UBTDIR   "UBTDIR"
#define	NINAB222_CMD_UBTACLC   "UBTACLC"
#define	NINAB222_CMD_UBTACLD   "UBTACLD"
#define	NINAB222_CMD_UBTLK   "UBTLK"
#define	NINAB222_PREFIX_SYMBOL_END   "\r\n"
	NINA-B222 parameter access commands.
#define	NINAB222_PREFIX_SYMBOL_QUERY   "?"
#define	NINAB222_PREFIX_SYMBOL_SET_VAL   "="
#define	NINAB222_PREFIX_SYMBOL_PLUS   "+"
#define	NINAB222_PREFIX_SYMBOL_AND   "&"
#define	NINAB222_PREFIX_SYMBOL_SEPARATOR   ","
#define	NINAB222_PREFIX_SYMBOL_SPACE   " "
#define	NINAB222_PREFIX_SYMBOL_PERCENT   "%"
#define	NINAB222_PREFIX_SYMBOL_NULL   ""
#define	NINAB222_PREFIX_SYMBOL_QUOTE   "\""
#define	NINAB222_PREFIX_SYMBOL_SPS   "sps://"
#define	NINAB222_PREFIX_SYMBOL_ZERO   "0"
#define	NINAB222_PREFIX_SYMBOL_ONE   "1"
#define	NINAB222_PREFIX_SYMBOL_TWO   "2"
#define	NINAB222_RSP_OK   "OK"
	NINA-B222 response value data.
#define	NINAB222_RSP_ERROR   "ERROR"
#define	NINAB222_ECHO_OFF   0
	NINA-B222 echo On/Off E data value.
#define	NINAB222_ECHO_ON   1
#define	NINAB222_MODE_COMMAND   0
	NINA-B222 start data mode value.
#define	NINAB222_MODE_DATA   1
#define	NINAB222_MODE_EXT_DATA   2
#define	NINAB222_MODE_PPP   3
#define	NINAB222_GAP_MODE_NON_PAIRING   0
	NINA-B222 bluetooth low energy role data values.
#define	NINAB222_GAP_MODE_PAIRING   1
#define	NINAB222_LR_ROLE_DISABLE   0
	NINA-B222 bluetooth low energy role data values.
#define	NINAB222_LR_ROLE_CENTRAL   1
#define	NINAB222_LR_ROLE_PERIPHERAL   2
#define	NINAB222_LR_ROLE_SIMULTANEOUS   3
#define	NINAB222_GAP_MODE_NON_CONN   1
	NINA-B222 connectability mode data values.
#define	NINAB222_GAP_MODE_CONN   2
#define	NINAB222_GAP_MODE_NON_DIS   1
	NINA-B222 connectability mode data values.
#define	NINAB222_GAP_MODE_LIM_DIS   2
#define	NINAB222_GAP_MODE_GEN_DISC   3
#define	NINAB222_ASCII_TABLE_START_NUM   48
	NINA-B222 ASCII zero data values.
#define	NINAB222_PIN_STATE_LOW   0
	NINA-B222 pin logic states data values.
#define	NINAB222_PIN_STATE_HIGH   1
#define	NINAB222_TX_DRV_BUFFER_SIZE   100
	NINA-B222 driver buffer size.
#define	NINAB222_RX_DRV_BUFFER_SIZE   300
#define	NINAB222_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	ninab222_return_value_t { NINAB222_OK = 0 , NINAB222_ERROR = -1 }
	NINA-B222 Click return value data. More...

Functions
void	ninab222_cfg_setup (ninab222_cfg_t *cfg)
	NINA-B222 configuration object setup function.
err_t	ninab222_init (ninab222_t *ctx, ninab222_cfg_t *cfg)
	NINA-B222 initialization function.
err_t	ninab222_generic_write (ninab222_t *ctx, uint8_t *data_in, uint16_t len)
	NINA-B222 data writing function.
err_t	ninab222_generic_read (ninab222_t *ctx, uint8_t *data_out, uint16_t len)
	NINA-B222 data reading function.
void	ninab222_hw_reset (ninab222_t *ctx)
	NINA-B222 HW reset function.
err_t	ninab222_write_cmd (ninab222_t *ctx, uint8_t *command)
	NINA-B222 command writing function.
err_t	ninab222_write_sys_cmd (ninab222_t *ctx, uint8_t *command)
	NINA-B222 system command writing function.
err_t	ninab222_write_cmd_param (ninab222_t *ctx, uint8_t *command, uint8_t *param)
	NINA-B222 command - parameter writing function.
err_t	ninab222_inquire_cmd (ninab222_t *ctx, uint8_t *command)
	NINA-B222 inquire command function.
err_t	ninab222_rst_def_cfg (ninab222_t *ctx)
	NINA-B222 set to factory defined configuration function.
err_t	ninab222_reboot_dce (ninab222_t *ctx)
	NINA-B222 reboot DCE function.
err_t	ninab222_set_bt_intf (ninab222_t *ctx)
	NINA-B222 store current configuration function.
err_t	ninab222_set_start_mode (ninab222_t *ctx, uint8_t start_mode)
	NINA-B222 sets start mode function.
err_t	ninab222_get_start_mode (ninab222_t *ctx)
	NINA-B222 get start mode function.
err_t	ninab222_set_enter_mode (ninab222_t *ctx, uint8_t enter_mode)
	NINA-B222 sets enter mode function.
err_t	ninab222_set_echo (ninab222_t *ctx, uint8_t echo_en)
	NINA-B222 set echo function.
err_t	ninab222_set_device_name (ninab222_t *ctx, uint8_t *device_name)
	NINA-B222 sets device name function.
err_t	ninab222_get_device_name (ninab222_t *ctx)
	NINA-B222 get device name function.
err_t	ninab222_set_le_role (ninab222_t *ctx, uint8_t le_role)
	NINA-B222 sets low energy role function.
err_t	ninab222_get_le_role (ninab222_t *ctx)
	NINA-B222 get low energy role function.
err_t	ninab222_get_peers_list (ninab222_t *ctx)
	NINA-B222 get low energy role function.
err_t	ninab222_set_default_cfg (ninab222_t *ctx)
	NINA-B222 sets the default configuration function.
err_t	ninab222_set_pairing_mode (ninab222_t *ctx, uint8_t p_mode)
	NINA-B222 sets pairing mode function.
err_t	ninab222_set_connectability (ninab222_t *ctx, uint8_t c_mode)
	NINA-B222 sets connectabilit mode function.
err_t	ninab222_get_connectability (ninab222_t *ctx)
	NINA-B222 sets connectabilit mode function.
err_t	ninab222_set_discoverability (ninab222_t *ctx, uint8_t d_mode)
	NINA-B222 sets discoverability mode function.
err_t	ninab222_get_discoverability (ninab222_t *ctx)
	NINA-B222 sets discoverability mode function.
err_t	ninab222_get_info (ninab222_t *ctx)
	NINA-B222 get module-info function.
err_t	ninab222_remote_peer (ninab222_t *ctx, uint8_t *domain)
	NINA-B222 default remote peer function.
err_t	ninab222_periph_pairing_cfg (ninab222_t *ctx)
	NINA-B222 default remote peer function.
void	ninab222_clear_to_send (ninab222_t *ctx, uint8_t cts)
	NINA-B222 set clear to send pin state function.
uint8_t	ninab222_request_to_send (ninab222_t *ctx)
	NINA-B222 get request to send pin state function.
void	ninab222_set_sry_pin (ninab222_t *ctx, uint8_t state)
	NINA-B222 set SRY pin state function.
void	ninab222_set_io5_pin (ninab222_t *ctx, uint8_t state)
	NINA-B222 set IO5 pin state function.

Detailed Description

This file contains API for NINA-B222 Click Driver.

Enumeration Type Documentation

ninab222_return_value_t

enum ninab222_return_value_t

NINA-B222 Click return value data.

Predefined enum values for driver return values.

Enumerator
NINAB222_OK
NINAB222_ERROR